Fzzy Config/me.fzzyhmstrs.fzzy_config.screen.widget.custom/CustomButtonWidget

CustomButtonWidget

open class CustomButtonWidget : CustomPressableWidget

A custom ButtonWidget implementation with builder and rendering improvements (and more features in general)

This constructor is for subclasses of this widget only. Buttons should be constructed with the builder, like vanilla buttons.

Author

fzzyhmstrs

Since

0.5.?, update to ActiveNarrationSupplier 0.6.3, improve memory footprint 0.6.5

Parameters

button X position

button Y position

width

button width in pixels

height

button height in pixels

pressAction

Consumer<CustomButtonWidget> action to invoke when the button is clicked or activated

narrationSupplier

ActiveNarrationSupplier converts a provided input text and the current active state of this widget into a narration text.

narrationAppender

Consumer<NarrationMessageBuilder> unlike the supplier, this is used to directly append additional narrations as needed to the message builder.

textures

TextureSet, default CustomPressableWidget.DEFAULT_TEXTURES. The textures for this button

child

TooltipChild, used to pass additional tooltip context. This button will pass and tooltip from this child out to its own parent (this button is also a TooltipChild)

renderMessage

If false, the label won't be rendered

Types

ActiveNarrationSupplier

@FunctionalInterface

fun interface ActiveNarrationSupplier

Builder

class Builder(message: Text, onPress: Consumer<CustomButtonWidget>)

Builds a CustomButtonWidget

Companion

object Companion

Properties

active

var active: Boolean

focused

var focused: Boolean

navigationOrder

var navigationOrder: Int

visible

var visible: Boolean

var x: Int

var y: Int

Functions

appendNarrations

override fun appendNarrations(builder: NarrationMessageBuilder)

drawMessage

open fun drawMessage(context: DrawContext, textRenderer: TextRenderer, x: Int, y: Int, width: Int, height: Int, color: Int)

Draws the widgets message with standard edge padding and positioning.

forEachChild

open override fun forEachChild(consumer: Consumer<ClickableWidget>)

getAlpha

open fun getAlpha(): Float

getBorder

open fun getBorder(direction: NavigationDirection): ScreenRect

getBottom

open fun getBottom(): Int

getFocusedPath

open fun getFocusedPath(): @Nullable GuiNavigationPath

getHeight

open override fun getHeight(): Int

getMessage

open override fun getMessage(): Text

getNarratedParts

open fun getNarratedParts(): MutableCollection<out Selectable>

getNavigationFocus

open override fun getNavigationFocus(): ScreenRect

getNavigationPath

open override fun getNavigationPath(navigation: GuiNavigation): @Nullable GuiNavigationPath

getRight

open fun getRight(): Int

getType

open override fun getType(): Selectable.SelectionType

getWidth

open override fun getWidth(): Int

isClickable

open fun isClickable(): Boolean

isHovered

open fun isHovered(): Boolean

isInteractable

open override fun isInteractable(): Boolean

isMouse

open fun isMouse(event: CustomWidget.MouseEvent): Boolean

isMouseOver

open override fun isMouseOver(mouseX: Double, mouseY: Double): Boolean

isSelected

open fun isSelected(): Boolean

mouseMoved

open fun mouseMoved(mouseX: Double, mouseY: Double)

onChar

open fun onChar(event: CustomWidget.CharEvent): Boolean

Handles char input events for custom widgets. Override this for handling keyboard inputs.

onKey

open override fun onKey(event: CustomWidget.KeyEvent): Boolean

Handles keyboard events for custom widgets. Override this for handling keyboard inputs.

onKeyRelease

open fun onKeyRelease(event: CustomWidget.KeyEvent): Boolean

Handles keyboard release events for custom widgets. Override this for handling keyboard inputs.

onMouse

open override fun onMouse(event: CustomWidget.MouseEvent): Boolean

Handles mouse click events for custom widgets. Override this or onPress for handling mouse inputs.

onMouseDrag

open fun onMouseDrag(event: CustomWidget.MouseEvent): Boolean

Handles mouse drag events for custom widgets. Override this for handling drag inputs

onMouseRelease

open fun onMouseRelease(event: CustomWidget.MouseEvent): Boolean

Handles mouse button release events for custom widgets. Override this for handling mouse inputs.

onMouseScroll

open fun onMouseScroll(event: CustomWidget.MouseEvent): Boolean

Handles mouse scroll events for custom widgets. Override this for handling mouse inputs.

onPress

open override fun onPress()

Action invoked whenever the button is clicked on or activated with Enter.

playDownSound

open fun playDownSound(soundManager: SoundManager)

provideNarrationLines

open fun provideNarrationLines(): List<Text>

Provides a list of text for appending into a Narration Hint. By default this will use the same lines passed from provideTooltipLines, with predefined values for the inputs

provideTooltipLines

open override fun provideTooltipLines(mouseX: Int, mouseY: Int, parentSelected: Boolean, keyboardFocused: Boolean): List<Text>

Provides a list of text lines for appending to a tooltip. Unlike appending in MC, the parent has final say on compiling the tooltip from the pieces given to it.

render